home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sftytrv.zip / SFTYTRV.DOC < prev    next >
Text File  |  1991-02-23  |  20KB  |  439 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.        
  9.                                   SFTYTRV 
  10.                               TURBULENT YEARS 
  11.                                 1960 - 1979                           
  12.                         "A Non-Trivial Trivia Game" 
  13.                          
  14.                                 Version 1.0 
  15.                              by Rick Thoma of 
  16.                                 VILLAGE BBS 
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.    INTRODUCTION ------------
  25.  
  26.    SFTYTRV is a fast paced History trivia game,  covering the period of 1960 
  27.    through 1979, the Decades of Turbulence.   This is the first of a planned 
  28.    series  of  such  "Non-Trivial Trivia Games"  designed to run as  a  door 
  29.    feature within the SPITFIRE Bulletin Board System. 
  30.     
  31.    The door can be installed as a sysop configurable command from  the Main, 
  32.    File or Message menus of SPITFIRE.   A  data file containing 500  History 
  33.    questions  is  randomly accessed and displayed to the screen.   With each 
  34.    question  that is displayed,  four multiple choice options  are  provided 
  35.    from which the player may select.   SFTYTRV allows the SYSOP to configure 
  36.    the delay time (defaults to 17  seconds)  that the  player  is allowed to 
  37.    read the question and respond with the number corresponding to the answer 
  38.    they wish to select. 
  39.  
  40.  
  41.    SFTYTRV COMMAND LINE PARAMETERS --------------------------------
  42.  
  43.    /D  - Designates the delay time (in seconds)  that the user is allowed to 
  44.    answer the question before it "times out". 17-20 seconds is suggested for 
  45.    this, as the questions are complex, and this is not a speed reading test. 
  46.  
  47.    /L - Allows local usage of SFTYTRV. 
  48.  
  49.    /P - Designates the drive, path, filename and extension of the high score
  50.         bulletin to be used with SFTYTRV.
  51.  
  52.  
  53.    DELAY TIME ---
  54.  
  55.    The /D command line parameter is available which will allow the Sysop  to 
  56.    designate  the delay time (in seconds)  that is allowed between the  time 
  57.    the  question  prompt is displayed to the screen and when the  user  must 
  58.    enter  the  desired  answer.    This is done using  the  /Dnn  (where  nn 
  59.    represents the number of seconds) command line parameter.  As an example, 
  60.    if the Sysop wishes to allow a 15  second delay, a /D15  would be entered 
  61.    on the command line as illustrated below: 
  62.    
  63.    SFTYTRV /D15 
  64.  
  65.    If  no /Dnn is designated at the command line,  SFTYTRV will default to a 
  66.    17 second delay. 
  67.  
  68.  
  69.    BULLETINS ---
  70.  
  71.    The  /P command line parameter will automatically create Ansi   and  Non-
  72.    Ansi high score bulletins for your BBS system.  
  73.    
  74.    If you would like to use this option,   a  "/P" should follow the SFTYTRV  
  75.    in the command line to indicate a valid  DOS path where the bulletin file 
  76.    will be created.  (NOTE: This should be the same as the display file path 
  77.    you have set up within SPITFIRE.)   The path is then followed by the file 
  78.    name of the bulletin to be  created.   It is not necessary to include the 
  79.    file extension.   SFTYTRV will automatically add a .BBS extension for the 
  80.    Non-Ansi  display  file  and a .CLR extension for the Ansi  display  file 
  81.    created.  The correct syntax should look like this: 
  82.                                                                                 
  83.    SFTYTRV /P C:\SF\DISPLAY\DORBUL1                                            
  84.                                                                                 
  85.    The "/P" command line is optional and SFTYTRV will operate perfectly fine 
  86.    without it.   However,  it is a convenient means of providing and posting 
  87.    high score bulletins for the Canadiana trivia door.                  
  88.               
  89.                                                                      
  90.    LOCAL USAGE ---        
  91.                                                                        
  92.    The  /L  command line parameter will allow SFTYTRV to be  played  locally 
  93.    without  requiring a SFDOORS.DAT,  SFMAIN.DAT,  SFMESS.DAT or  SFFILE.DAT 
  94.    file.  Using the /L command line parameter disables the program's carrier 
  95.    detect monitoring and redirection of the game through the comm port.  For 
  96.    local operation of SFTYTRV enter the following command at the DOS prompt: 
  97.  
  98.    C:> SFTYTRV /L
  99.     
  100.  
  101.    **   SPECIAL  NOTE **  The /L,  /P and /D command parameters can  be  used 
  102.    together on the same command line. 
  103.  
  104.    It should also be noted that the /D, /P and /L command line parameters may 
  105.    appear in any order on the command line.   SFTYTRV does NOT require  these 
  106.    to be used in a specific order. 
  107.  
  108.  
  109.  
  110.    SFTYTRV SETUP AS A SPITFIRE DOOR ---------------------------------
  111.  
  112.    To  set  up SFTYTRV to be executed as a door,  it is recommended  that  a 
  113.    separate  directory be set up for it.   For explanation purposes,   let's 
  114.    assume  the  directory  DOORA  is created for  use  with  SFTYTRV.    The 
  115.    following files must then be placed in the directory: 
  116.  
  117.    SFTYTRV.EXE    The actual game program. 
  118.  
  119.    SFTYTRV.DAT    The data file containing the trivia questions. 
  120.  
  121.    SFTYTRV.TOP    This is a listing of the top ten players.  SFTYTRV.EXE 
  122.                   will create this file if it is not found. 
  123.  
  124.    SFTYTRV.LMT    This allows you to set time limits according to the 
  125.                   callers security level. 
  126.  
  127.    The Sysop will then need to use a text editor to edit the SF.BAT file  as 
  128.    illustrated below: 
  129.  
  130.    :DOOR_A COPY  SFDOORS.DAT C:\SF\DOORA SFTYTRV ERASE SFDOORS.DAT GOTO LOOP 
  131.    :DOOR_B 
  132.  
  133.  
  134.    You  will  notice that the commands needed to execute SFTYTRV are  placed 
  135.    between  the :DOOR_A and GOTO LOOP command lines.   These are entered  in 
  136.    place  of the existing REM Place Program Name Here.   The following  will 
  137.    briefly  explain each of the commands which were set up within SF.BAT  to 
  138.    run SFTYTRV as a SPITFIRE Door program: 
  139.  
  140.    SFDOORS.DAT  is  created automatically by SPITFIRE when a user  enters  a 
  141.    door.   It contains information about the user such as name and password.  
  142.    SFTYTRV   requires   access  to  the  information   within   SFDOORS.DAT.  
  143.    Therefore,   before  executing  the  program it must  be  copied  to  the 
  144.    directory in which SFTYTRV is running. 
  145.  
  146.    SFTYTRV is the program name and executes the game program from within the 
  147.    door program. 
  148.  
  149.    Once  the user has terminated the game play of SFTYTRV,  SPITFIRE  erases 
  150.    the SFDOORS.DAT file. 
  151.  
  152.  
  153.  
  154.    SFTYTRV SETUP AS A SYSOP CONFIGURABLE COMMAND ---------------------------
  155.    -------------------
  156.  
  157.    SPITFIRE has a sysop configurable command for the Main,  Message and File 
  158.    menus.    The sysop configurable command is executed through a batch file 
  159.    which  corresponds  to the menu it is being run from.   In  other  words, 
  160.    SFMAIN.BAT  runs  the  sysop  configurable command from  the  Main  Menu, 
  161.    SFMESS.BAT runs the one from the Message Menu and SFFILE.BAT the one from 
  162.    the File Menu.   The commands necessary to execute SFTYTRV can be set  up 
  163.    in  the batch file which corresponds to the menu you wish to have SFTYTRV 
  164.    run from. 
  165.  
  166.    The  first thing you will need to establish is which of these  menus  you 
  167.    wish  to use to run SFTYTRV.   For this purpose,  let's assume that it is 
  168.    going  to be set up so it can be run from the Main Menu.   (It should  be 
  169.    noted  the set up procedure is the same regardless of which Menu you  are 
  170.    running SFTYTRV from.) 
  171.  
  172.    Next,   you will need to decide what you wish to name the command  option 
  173.    and  establish  what security level will be required for  users  of  your 
  174.    system  to be able to access this option.   Once this is  determined  you 
  175.    will  need to modify the SFMAIN.MNU file using your favorite text editor, 
  176.    as  long as it saves in ASCII format.   (Refer to the SPITFIRE manual for 
  177.    further documentation on this if needed.  It should also be noted that if 
  178.    SFTYTRV  were being set up to run from the File Menu,  you would need  to 
  179.    modify the SFFILE.MNU file and if it was being set up to be run from  the 
  180.    Message Menu you would need to modify the SFMSG.MNU file.) 
  181.  
  182.  
  183.    Examining  the  default  SFMAIN.MNU  file,  you  will  notice  the  sysop 
  184.    configurable command appears as: 
  185.  
  186.         <K>............. Add Your Own,,1000,@ 
  187.  
  188.  
  189.    This  will need to be replaced with a Command Character that will be used 
  190.    to select the option from the menu.  It is ABSOLUTELY IMPERATIVE that the 
  191.    Command  Character  must not duplicate an existing Command Character  for 
  192.    another  menu option.   You will then need to include a brief description 
  193.    of  the  door program you are running,  two commas,  the  security  level 
  194.    required to access this feature,  and another comma followed by the a  @.  
  195.    The @ must not be changed!   (For more detailed  information on modifying 
  196.    your SFMAIN.MNU, SFMSG.MNU or SFFILE.MNU refer to your SPITFIRE manual.) 
  197.  
  198.        <K>.... Brief Program Description,,10,@ 
  199.  
  200.    Now you will need to modify the corresponding batch file, SFMAIN.BAT,  so 
  201.    that it can be executed from the Main Menu.   Do this using your favorite 
  202.    text editor,  as long as it saves in ASCII format.  (Again,  it should be 
  203.    noted  that if SFTYTRV were being set up to run from the File Menu,   you 
  204.    would need to modify the SFFILE.BAT file and if it was being set up to be 
  205.    run from the Message Menu you would need to modify the SFMESS.BAT file.) 
  206.  
  207.    Place  the SFTYTRV.EXE file in the directory you wish to run the  program 
  208.    from.   SFTYTRV will create its own player score file, SFTYTRV.TOP, if it 
  209.    does not already exist. 
  210.  
  211.    The commands set up in the SFMAIN.BAT file are very similar to those used 
  212.    for executing the game through a door in the SF.BAT file.   For instance, 
  213.    if  you  were  running  SFTYTRV from the  main  SPITFIRE  directory  your 
  214.    SFMAIN.BAT file might look like this: 
  215.  
  216.        ECHO OFF 
  217.        BRK OFF 
  218.        SFTYTRV 
  219.        BRK ON 
  220.  
  221.    (BRK  is  not included in the SFTYTRV package because it is  written  and 
  222.    copyrighted by Solid Systems, 1985, but can be downloaded from The Mother 
  223.    Board  BBS  and  Buffalo  Creek's BBS as well as a number  of  other  BBS 
  224.    systems.  BRK is not required to run SFTYTRV, however,  it is recommended 
  225.    since  it will prevent a user using the CTRL BRK command to terminate the 
  226.    batch file, gaining access to your system at the DOS level.) 
  227.  
  228.    If  you wish to set SFTYTRV up in a separate subdirectory from  SPITFIRE, 
  229.    for instance,  a  subdirectory named SFTYTRV,  your batch file might look 
  230.    like this. 
  231.  
  232.        ECHO OFF 
  233.        BRK OFF 
  234.        COPY SFMAIN.DAT \SF\SFTYTRV 
  235.        CD \SF\SFTYTRV 
  236.        SFTYTRV 
  237.        ERASE SFMAIN.DAT 
  238.        CD \SF 
  239.        BRK ON 
  240.  
  241.  
  242.    When  SFTYTRV is executed,  from either the door with the SF.BAT file  or 
  243.    from the sysop configurable command through a menu with the corresponding 
  244.    batch  file,   it  will first look for the  SFMAIN.DAT  file,   then  the 
  245.    SFMESS.DAT  file,   then the SFFILE.DAT file and lastly  the  SFDOORS.DAT 
  246.    file.    It  will look for each of these files until it finds it and  the 
  247.    commands  required for its execution.   If none of these files are found, 
  248.    SFTYTRV will halt its execution. 
  249.  
  250.  
  251.    DTE LOCK FEATURE ----------------
  252.  
  253.    SFTYTRV  automatically detects if the DTE is locked at 19200   baud.   If 
  254.    SFTYTRV  detects that the DTE is locked,  then SFTYTRV opens  the  serial 
  255.    port to the maximum baud rate of your system.  If SFTYTRV does not detect 
  256.    that  the DTE is locked,  then the serial port is opened to the baud rate 
  257.    of the caller. 
  258.  
  259.  
  260.    SFTYTRV ON A MULTI-NODE SYSTEM -------------------------------
  261.  
  262.    SFTYTRV  is  fully  compatible for operation on a  multi-node  BBS.    It 
  263.    automatically  handles any file locking and file sharing required  during 
  264.    the doors execution. 
  265.  
  266.  
  267.    SYSOP FEATURES --------------
  268.  
  269.    First,   a  status line is now displayed on the BBS monitor that provides 
  270.    information concerning the caller's name, baud rate of the caller and the 
  271.    security level of the caller. 
  272.  
  273.    A  SFTYTRV.LMT  file allows the sysop to establish a time limit for  door 
  274.    play  according to the security level the caller has on the system.    To 
  275.    modify the accompanying SFTYTRV.LMT file,  use your favorite text  editor 
  276.    to  represent  the  various security levels you have  available  on  your 
  277.    system,   a  comma then the corresponding time you wish to allow for that 
  278.    particular security level in minutes.   For instance,  it might look like 
  279.    this: 
  280.  
  281.    10,15 25,20 50,25 999,30 
  282.  
  283.    Each security level should begin a new line and you should have a setting 
  284.    for each security level you have available on your system.  If you do not 
  285.    have  a time limit set for a particular security SFTYTRV will default  to 
  286.    the level 10 security level setting. 
  287.  
  288.    Pressing the Shift Key and the F1  key simultaneously will terminate game 
  289.    play of SFTYTRV and return the caller back to the BBS. Pressing the Shift 
  290.    Key and the F9 key simultaneously will terminate game play of SFTYTRV and 
  291.    log  the  caller off of the BBS.   If the Shift Key and the F9   key  are 
  292.    pressed together,  logging the caller off the BBS,  SPITFIRE will recycle 
  293.    and return to the SPITFIRE Ready For Caller Prompt. 
  294.  
  295.  
  296.    SFTYTRV EXECUTION ------------------
  297.  
  298.    When  first  executed,  SFTYTRV will display a list of the Top  Ten  high 
  299.    score players and the percentage of correct responses they achieved while 
  300.    playing SFTYTRV.   Initially, this will be a dummy listing with ten lines 
  301.    that display: 
  302.  
  303.       0%...............YOUR NAME COULD BE HERE 
  304.  
  305.    However,   as  the game is played,  this will fill with the name  of  the 
  306.    players,  their percentage ratings and the date that the player was added 
  307.    to the top ten listing. 
  308.  
  309.    NOTE:  At least twenty  questions  must  be attempted before SFTYTRV will 
  310.    figure the percentage rating for the player. 
  311.  
  312.    To keep things interesting...the Sysop can erase the file which  contains 
  313.    the  top  ten listings SFTYTRV.TOP on a routine basis to give  additional 
  314.    players a chance to have their name added to the list. 
  315.  
  316.    As  the  top  ten list is displayed,  at the bottom of the  screen  is  a 
  317.    question  which prompts the user whether they want to have ANSI  Graphics 
  318.    (y/n)?   available to them during game play.  If the user responds with a 
  319.    y (for yes)  the game will display in color and if the user responds with 
  320.    a n (for no), the game will display in monochrome. 
  321.  
  322.  
  323.  
  324.    PLAYING SFTYTRV ----------------
  325.  
  326.    Immediately after pressing any key (other than <Q> for Quit) from the Top 
  327.    Ten listing the game screen is displayed.   The screen will look like the 
  328.    following: 
  329.  
  330.    ---------------------------------------------------------------------
  331.  
  332.     ┌───────────────────────────────────────────────┐
  333.     │  >>>>>>>>>  DECADES OF TURBULENCE  <<<<<<<<<  │
  334.     │                  1960 - 1979           Ver 1  │
  335.     │          "A Non-Trivial Trivia Game"          │
  336.     │           Freeware from Village BBS           │
  337.     │  In Cooperation with Buffalo Creek Software   │
  338.     │ Copyright (C) Rick Thoma All Rights Reserved  │
  339.     └───────────────────────────────────────────────┘
  340.  
  341.     ----------------------------------------------- 
  342.  
  343.     RIGHT: 0                        WRONG: 0 
  344.  
  345.     QUESTION: 
  346.     The trivia question will be displayed 
  347.     here. 
  348.  
  349.     <1> Choice 1                        <2> Choice 2 
  350.     <3> Choice 3                        <4> Choice 4 
  351.  
  352.              Enter Answer: [ 1 2 3 4 <Q>uit]? 
  353.  
  354.    ---------------------------------------------------------------------
  355.     
  356.    The  first randomly chosen trivia question is selected from the data file 
  357.    and is displayed to the screen. 
  358.  
  359.    The  player makes his selection by entering the corresponding number.  As 
  360.    the game progresses,  SFTYTRV will provide a running total of the correct 
  361.    answers  and  also of the wrong answers the user has selected during  the 
  362.    game play. 
  363.  
  364.    If the timer should elapse before you respond, SFTYTRV will count this as 
  365.    a  wrong response and add an incorrect answer to the total WRONG  answers 
  366.    obtained so far. 
  367.  
  368.  
  369.    EXITING PLAY ------------
  370.  
  371.    When you are ready to exit the game,  simply select press "Q" for <Q>uit.  
  372.    If  you  qualify  as one of the top ten players to  date,   SFTYTRV  will 
  373.    congratulate  you  for becoming one of the top ten scorers and  add  your 
  374.    name  to the Top Ten listing.   You will once again see the Top Ten  list 
  375.    displayed with your name added to the list. 
  376.  
  377.    If  you  exit  the game before you have completed  the  twenty  questions 
  378.    required for eligibility to the Top Ten list or if you do not qualify  as 
  379.    a Top Ten player,  the Top Ten listing will be displayed and you will  be 
  380.    prompted to press any key to return to SPITFIRE. 
  381.  
  382.  
  383.    DISTRIBUTION ------------
  384.  
  385.    Please feel free to share SFTYTRV.ZIP with others.   However,  it must be 
  386.    distributed with SFTYTRV.EXE,  SFTYTRV.DAT, SFTYTRV.TOP,  SFTYTRV.LMT and 
  387.    the SFTYTRV.DOC in the SFTYTRV.ZIP distribution package.   The files must 
  388.    not be altered in any way or by any means. 
  389.  
  390.  
  391.    PUBLIC DOMAIN - DISCLAIMER --------------------------
  392.  
  393.    SFTYTRV is distributed under the public domain concept.  The software and 
  394.    its  accompanying documentation are provided "as is"  without  warranties 
  395.    expressed  or  implied  as to the performance  or  merchantability.    No 
  396.    registration  fee is required and the program can be distributed  freely.  
  397.    However, by the use of SFTYTRV, the user assumes all responsibilities and 
  398.    agrees that Rick Thoma of Village BBS shall  not  be held liable  for any 
  399.    damage incurred to hardware, software or peripheral devices while running 
  400.    same. 
  401.  
  402.    Many thanks are indeed owed to Mike Woltz of Buffalo Creek BBS (515)-225-
  403.    8496   for his assistance.   Without his help this program would not have 
  404.    been possible.   I  gather that Mike does not generally make the  support 
  405.    programs available to non SPITFIRE Sysops.   Well,  he was kind enough to 
  406.    waive  the rules,  and allow this Wildcat Sysop to provide you with  this 
  407.    new program.  I hope you enjoy it! 
  408.  
  409.    (Special thanks to Brenda for the proof reading!)
  410.  
  411.  
  412.    History -------
  413.  
  414.    Release 1    SFTYTRV released. 
  415.  
  416.  
  417.  
  418.    SFTYTRV and (certain) other  SPITFIRE programs are available for download 
  419.    from: 
  420.  
  421.         Buffalo Creek BBS                        Village BBS 
  422.         Sysop - Mike Woltz                    Sysop - Rick Thoma 
  423.           (515) 225-8496                        *(   )    -    
  424.        19200/9600/2400/1200                  19200/9600/2400/1200 
  425.                                              
  426.  
  427.    **    NOTE:   The Village BBS may be moving soon, hence there is no phone 
  428.    number  provided!    You will always be able to find it via  the  FIDONET 
  429.    Nodelist.  This move is planned for the Spring of 1991. 
  430.    
  431.    The  newest versions of this or any other SPITFIRE door (that I manage to 
  432.    find the time for) will always be available on Mike's board  before  they 
  433.    become available anywhere else, so calling him would in most instances be 
  434.    the best way to obtain them.  
  435.  
  436.    Look for additions to this "Non-Trivial Trivia" series soon! 
  437.  
  438.  
  439.